<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Unity ML-Agents Toolkit: FloatPropertiesChannel Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygenbase.css" rel="stylesheet" type="text/css" />
<link href="unity.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Unity ML-Agents Toolkit
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">FloatPropertiesChannel Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Side channel that is comprised of a collection of float variables.  
 <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html#details">More...</a></p>

<p>Inherits <a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html">SideChannel</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aeedc125ae17ae669a1de31993c35a4f7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html#aeedc125ae17ae669a1de31993c35a4f7">FloatPropertiesChannel</a> (Guid channelId=default(Guid))</td></tr>
<tr class="memdesc:aeedc125ae17ae669a1de31993c35a4f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the side channel with the provided channel ID.  <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html#aeedc125ae17ae669a1de31993c35a4f7">More...</a><br /></td></tr>
<tr class="separator:aeedc125ae17ae669a1de31993c35a4f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca97894eaccb3dbb7864f8cfa7f8ec93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html#aca97894eaccb3dbb7864f8cfa7f8ec93">Set</a> (string key, float value)</td></tr>
<tr class="memdesc:aca97894eaccb3dbb7864f8cfa7f8ec93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets one of the float properties of the environment.  <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html#aca97894eaccb3dbb7864f8cfa7f8ec93">More...</a><br /></td></tr>
<tr class="separator:aca97894eaccb3dbb7864f8cfa7f8ec93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8c13b8d2df9eccaa7a8da3a003fa6a7"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html#ac8c13b8d2df9eccaa7a8da3a003fa6a7">GetWithDefault</a> (string key, float defaultValue)</td></tr>
<tr class="memdesc:ac8c13b8d2df9eccaa7a8da3a003fa6a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get an Environment property with a default value.  <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html#ac8c13b8d2df9eccaa7a8da3a003fa6a7">More...</a><br /></td></tr>
<tr class="separator:ac8c13b8d2df9eccaa7a8da3a003fa6a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a3f7ba54f3144e2cea983a17ea16ed3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html#a9a3f7ba54f3144e2cea983a17ea16ed3">RegisterCallback</a> (string key, Action&lt; float &gt; action)</td></tr>
<tr class="memdesc:a9a3f7ba54f3144e2cea983a17ea16ed3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers an action to be performed everytime the property is changed.  <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html#a9a3f7ba54f3144e2cea983a17ea16ed3">More...</a><br /></td></tr>
<tr class="separator:a9a3f7ba54f3144e2cea983a17ea16ed3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a210172bb3ec64424629d728b7c5fffa1"><td class="memItemLeft" align="right" valign="top">IList&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html#a210172bb3ec64424629d728b7c5fffa1">Keys</a> ()</td></tr>
<tr class="memdesc:a210172bb3ec64424629d728b7c5fffa1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a list of all the string identifiers of the properties currently present.  <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html#a210172bb3ec64424629d728b7c5fffa1">More...</a><br /></td></tr>
<tr class="separator:a210172bb3ec64424629d728b7c5fffa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a363b0216a1a7077a8fd2bad700f816a0"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html#a363b0216a1a7077a8fd2bad700f816a0">OnMessageReceived</a> (<a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1IncomingMessage.html">IncomingMessage</a> msg)</td></tr>
<tr class="memdesc:a363b0216a1a7077a8fd2bad700f816a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is called by the communicator every time a message is received from Python by the <a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html" title="Side channels provide an alternative mechanism of sending/receiving data from Unity to Python that is...">SideChannel</a>.Can be called multiple times per simulation step if multiple messages were sent.  <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html#a363b0216a1a7077a8fd2bad700f816a0">More...</a><br /></td></tr>
<tr class="separator:a363b0216a1a7077a8fd2bad700f816a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html">SideChannel</a></td></tr>
<tr class="memitem:a2a56f2a844918fd3ef60facebf0d73b0 inherit pro_methods_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html#a2a56f2a844918fd3ef60facebf0d73b0">QueueMessageToSend</a> (<a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1OutgoingMessage.html">OutgoingMessage</a> msg)</td></tr>
<tr class="memdesc:a2a56f2a844918fd3ef60facebf0d73b0 inherit pro_methods_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queues a message to be sent to Python during the next simulation step.  <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html#a2a56f2a844918fd3ef60facebf0d73b0">More...</a><br /></td></tr>
<tr class="separator:a2a56f2a844918fd3ef60facebf0d73b0 inherit pro_methods_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header properties_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td colspan="2" onclick="javascript:toggleInherit('properties_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html">SideChannel</a></td></tr>
<tr class="memitem:a6c254da618b29e02fafe4afdfe226de2 inherit properties_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td class="memItemLeft" align="right" valign="top">Guid&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html#a6c254da618b29e02fafe4afdfe226de2">ChannelId</a><code> [get, protected set]</code></td></tr>
<tr class="memdesc:a6c254da618b29e02fafe4afdfe226de2 inherit properties_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td class="mdescLeft">&#160;</td><td class="mdescRight">An int identifier for the <a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html" title="Side channels provide an alternative mechanism of sending/receiving data from Unity to Python that is...">SideChannel</a>.  <a href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html#a6c254da618b29e02fafe4afdfe226de2">More...</a><br /></td></tr>
<tr class="separator:a6c254da618b29e02fafe4afdfe226de2 inherit properties_classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Side channel that is comprised of a collection of float variables. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aeedc125ae17ae669a1de31993c35a4f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeedc125ae17ae669a1de31993c35a4f7">&#9670;&nbsp;</a></span>FloatPropertiesChannel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html">FloatPropertiesChannel</a> </td>
          <td>(</td>
          <td class="paramtype">Guid&#160;</td>
          <td class="paramname"><em>channelId</em> = <code>default(Guid)</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes the side channel with the provided channel ID. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">channelId</td><td>ID for the side channel.</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac8c13b8d2df9eccaa7a8da3a003fa6a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8c13b8d2df9eccaa7a8da3a003fa6a7">&#9670;&nbsp;</a></span>GetWithDefault()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float GetWithDefault </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>defaultValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get an Environment property with a default value. </p>
<p>If there is a value for this property, it will be returned, otherwise, the default value will be returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">key</td><td>The string identifier of the property.</td></tr>
    <tr><td class="paramname">defaultValue</td><td>The default value of the property.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>

</div>
</div>
<a id="a210172bb3ec64424629d728b7c5fffa1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a210172bb3ec64424629d728b7c5fffa1">&#9670;&nbsp;</a></span>Keys()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IList&lt;string&gt; Keys </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a list of all the string identifiers of the properties currently present. </p>
<dl class="section return"><dt>Returns</dt><dd>The list of string identifiers </dd></dl>

</div>
</div>
<a id="a363b0216a1a7077a8fd2bad700f816a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a363b0216a1a7077a8fd2bad700f816a0">&#9670;&nbsp;</a></span>OnMessageReceived()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">override void OnMessageReceived </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1IncomingMessage.html">IncomingMessage</a>&#160;</td>
          <td class="paramname"><em>msg</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Is called by the communicator every time a message is received from Python by the <a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html" title="Side channels provide an alternative mechanism of sending/receiving data from Unity to Python that is...">SideChannel</a>.Can be called multiple times per simulation step if multiple messages were sent. </p>

<p>Implements <a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1SideChannel.html#a1448193c1661c98849063d89db123fc0">SideChannel</a>.</p>

</div>
</div>
<a id="a9a3f7ba54f3144e2cea983a17ea16ed3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a3f7ba54f3144e2cea983a17ea16ed3">&#9670;&nbsp;</a></span>RegisterCallback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RegisterCallback </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Action&lt; float &gt;&#160;</td>
          <td class="paramname"><em>action</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers an action to be performed everytime the property is changed. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">key</td><td>The string identifier of the property.</td></tr>
    <tr><td class="paramname">action</td><td>The action that ill be performed. Takes a float as input.</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="aca97894eaccb3dbb7864f8cfa7f8ec93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca97894eaccb3dbb7864f8cfa7f8ec93">&#9670;&nbsp;</a></span>Set()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Set </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets one of the float properties of the environment. </p>
<p>This data will be sent to Python.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">key</td><td>The string identifier of the property.</td></tr>
    <tr><td class="paramname">value</td><td>The float value of the property.</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="FloatPropertiesChannel_8cs.html">FloatPropertiesChannel.cs</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceUnity.html">Unity</a></li><li class="navelem"><a class="el" href="namespaceUnity_1_1MLAgents.html">MLAgents</a></li><li class="navelem"><a class="el" href="namespaceUnity_1_1MLAgents_1_1SideChannels.html">SideChannels</a></li><li class="navelem"><a class="el" href="classUnity_1_1MLAgents_1_1SideChannels_1_1FloatPropertiesChannel.html">FloatPropertiesChannel</a></li>
  </ul>
</div>
</body>
</html>
